IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/BuildSearchableOptionsTask

BuildSearchableOptionsTask

@CacheableTask
abstract class BuildSearchableOptionsTask : JavaExec, RunnableIdeAware

Builds an index of UI components (searchable options) for the plugin. This task runs a headless IDE instance to collect all the available options provided by the plugin's Settings.

If your plugin doesn't implement custom settings, it is recommended to disable it with IntelliJPlatformExtension.buildSearchableOptions.

In the case of running the task for the plugin which has the IntelliJPlatformExtension.PluginConfiguration.ProductDescriptor configures, a warning will be logged regarding potential issues with running headless IDE for paid plugins. It is possible to mute this warning with BuildFeature.PAID_PLUGIN_SEARCHABLE_OPTIONS_WARNING build feature flag.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : Registrable

Properties

Link copied to clipboard
@get:Internal
abstract val autoReload: Property<Boolean>

Enables auto-reload of dynamic plugins. Dynamic plugin will be reloaded automatically when its content is modified.

Link copied to clipboard
@get:Internal
val conventionMapping: ConventionMapping
Link copied to clipboard
@get:Internal
@get:Optional
abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

Link copied to clipboard
@get:Internal
var enabled: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

Link copied to clipboard
val javaLauncher: Property<JavaLauncher>
Link copied to clipboard
val jvmArguments: ListProperty<String>
Link copied to clipboard
val mainClass: Property<String>
Link copied to clipboard
val mainModule: Property<String>
Link copied to clipboard
val modularity: ModularitySpec
Link copied to clipboard
@get:OutputDirectory
abstract val outputDirectory: DirectoryProperty

The directory to which searchable options will be generated.

Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:InputFile
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val pluginXml: RegularFileProperty

Holds the path to the patched plugin.xml file.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
@get:Internal
abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

Link copied to clipboard
@get:Internal
abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

Link copied to clipboard
@get:Internal
abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:Internal
abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxDirectory: DirectoryProperty

The directory containing content read and produced by the running IDE.

Link copied to clipboard
@get:Internal
abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

Link copied to clipboard
@get:Internal
abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val showPaidPluginWarning: Property<Boolean>

Emit warning if the task is executed by a paid plugin. Can be disabled with BuildFeature.PAID_PLUGIN_SEARCHABLE_OPTIONS_WARNING.

Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
val timeout: Property<Duration>

Functions

Link copied to clipboard
open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)
Link copied to clipboard
open override fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open override fun args(vararg args: Any): JavaExec
open override fun args(args: MutableIterable<*>): JavaExecSpec
Link copied to clipboard
open override fun bootstrapClasspath(vararg classpath: Any): JavaExec
Link copied to clipboard
open override fun classpath(vararg paths: Any): JavaExec
Link copied to clipboard
open operator override fun compareTo(other: Task): Int
Link copied to clipboard
open override fun configure(closure: Closure<Any>): Task
Link copied to clipboard
open fun conventionMapping(property: String, mapping: Closure<Any>): Task
open fun conventionMapping(property: String, mapping: Callable<*>): Task
Link copied to clipboard
open override fun copyTo(options: JavaForkOptions): JavaExec
open override fun copyTo(target: ProcessForkOptions): JavaExec
Link copied to clipboard
open override fun debugOptions(action: Action<JavaDebugOptions>)
Link copied to clipboard
open override fun dependsOn(vararg paths: Any): Task
Link copied to clipboard
open override fun doFirst(action: Closure<Any>): Task
open override fun doFirst(action: Action<in Task>): Task
open override fun doFirst(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doLast(action: Closure<Any>): Task
open override fun doLast(action: Action<in Task>): Task
open override fun doLast(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open override fun environment(environmentVariables: MutableMap<String, *>): JavaExec
open override fun environment(name: String, value: Any): JavaExec
Link copied to clipboard
open override fun exec()

Executes the task, configures and runs the IDE.

Link copied to clipboard
open override fun executable(executable: Any): JavaExec
Link copied to clipboard
open override fun finalizedBy(vararg paths: Any): Task
Link copied to clipboard
open override fun getActions(): MutableList<Action<in Task>>
Link copied to clipboard
open override fun getAllJvmArgs(): MutableList<String>
Link copied to clipboard
open override fun getAnt(): AntBuilder
Link copied to clipboard
open override fun getArgs(): MutableList<String>?
Link copied to clipboard
open override fun getArgumentProviders(): MutableList<CommandLineArgumentProvider>
Link copied to clipboard
@Internal
open override fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open override fun getBootstrapClasspath(): FileCollection
Link copied to clipboard
open override fun getClasspath(): FileCollection
Link copied to clipboard
@Internal
open override fun getCommandLine(): MutableList<String>
Link copied to clipboard
@Internal
open override fun getConvention(): Convention
Link copied to clipboard
open override fun getDebug(): Boolean
Link copied to clipboard
open override fun getDebugOptions(): JavaDebugOptions
Link copied to clipboard
open override fun getDefaultCharacterEncoding(): String?
Link copied to clipboard
open override fun getDependsOn(): MutableSet<Any>
Link copied to clipboard
open override fun getDescription(): String?
Link copied to clipboard
open override fun getDestroyables(): TaskDestroyables
Link copied to clipboard
open override fun getDidWork(): Boolean
Link copied to clipboard
open override fun getEnableAssertions(): Boolean
Link copied to clipboard
@Internal
open override fun getEnvironment(): MutableMap<String, Any>
Link copied to clipboard
@Internal
open override fun getErrorOutput(): OutputStream
Link copied to clipboard
@Internal(value = "covered by getJavaVersion")
@Nullable
open override fun getExecutable(): String?
Link copied to clipboard
@Internal
open fun getExecutionResult(): Provider<ExecResult>
Link copied to clipboard
open override fun getExtensions(): ExtensionContainer
Link copied to clipboard
open override fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open override fun getGroup(): String?
Link copied to clipboard
open override fun getIdentityPath(): Path
Link copied to clipboard
open override fun getInputs(): TaskInputsInternal
Link copied to clipboard
@Input
open fun getJavaVersion(): JavaVersion
Link copied to clipboard
open override fun getJvmArgs(): MutableList<String>?
Link copied to clipboard
open override fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>
Link copied to clipboard
@Internal
open override fun getLifecycleDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getLocalState(): TaskLocalState
Link copied to clipboard
open override fun getLogger(): Logger
Link copied to clipboard
open override fun getLogging(): LoggingManager
Link copied to clipboard
open override fun getMaxHeapSize(): String?
Link copied to clipboard
open override fun getMinHeapSize(): String?
Link copied to clipboard
open override fun getMustRunAfter(): TaskDependency
Link copied to clipboard
open override fun getName(): String
Link copied to clipboard
open override fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open override fun getOutputs(): TaskOutputsInternal
Link copied to clipboard
open override fun getPath(): String
Link copied to clipboard
open override fun getProject(): Project
Link copied to clipboard
open override fun getReasonNotToTrackState(): Optional<String>
Link copied to clipboard
open override fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open override fun getSharedResources(): MutableList<ResourceLock>
Link copied to clipboard
open override fun getShouldRunAfter(): TaskDependency
Link copied to clipboard
@Internal
open override fun getStandardInput(): InputStream
Link copied to clipboard
@Internal
open override fun getStandardOutput(): OutputStream
Link copied to clipboard
open override fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
open override fun getSystemProperties(): MutableMap<String, Any>
Link copied to clipboard
open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>
Link copied to clipboard
open override fun getTaskDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getTaskIdentity(): TaskIdentity<*>
Link copied to clipboard
open override fun getTemporaryDir(): File
Link copied to clipboard
open override fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
@Internal
open override fun getWorkingDir(): File
Link copied to clipboard
open override fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open override fun hasTaskActions(): Boolean
Link copied to clipboard
Link copied to clipboard
@Input
open override fun isIgnoreExitValue(): Boolean
Link copied to clipboard
open override fun jvmArgs(vararg arguments: Any): JavaExec
open override fun jvmArgs(arguments: MutableIterable<*>): JavaExec
Link copied to clipboard
open override fun mustRunAfter(vararg paths: Any): Task
Link copied to clipboard
open override fun notCompatibleWithConfigurationCache(reason: String)
Link copied to clipboard
open override fun onlyIf(onlyIfClosure: Closure<Any>)
open override fun onlyIf(spec: Spec<in Task>)
open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open override fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open override fun property(propertyName: String): Any?
Link copied to clipboard
open override fun setActions(replacements: MutableList<Action<in Task>>)
Link copied to clipboard
open override fun setAllJvmArgs(arguments: MutableIterable<*>)
open override fun setAllJvmArgs(arguments: MutableList<String>)
Link copied to clipboard
open override fun setArgs(applicationArgs: MutableIterable<*>?): JavaExec
open override fun setArgs(applicationArgs: MutableList<String>?): JavaExec
Link copied to clipboard
open fun setArgsString(args: String): JavaExec
Link copied to clipboard
open override fun setBootstrapClasspath(classpath: FileCollection)
Link copied to clipboard
open override fun setClasspath(classpath: FileCollection): JavaExec
Link copied to clipboard
open override fun setDebug(enabled: Boolean)
Link copied to clipboard
open override fun setDefaultCharacterEncoding(defaultCharacterEncoding: String?)
Link copied to clipboard
open override fun setDependsOn(dependsOn: MutableIterable<*>)
Link copied to clipboard
open override fun setDescription(description: String?)
Link copied to clipboard
open override fun setDidWork(didWork: Boolean)
Link copied to clipboard
open override fun setEnableAssertions(enabled: Boolean)
Link copied to clipboard
open override fun setEnvironment(environmentVariables: MutableMap<String, *>)
Link copied to clipboard
open override fun setErrorOutput(outputStream: OutputStream): JavaExec
Link copied to clipboard
open override fun setExecutable(executable: Any)
open override fun setExecutable(executable: String)
Link copied to clipboard
open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setGroup(group: String?)
Link copied to clipboard
open override fun setIgnoreExitValue(ignoreExitValue: Boolean): JavaExecSpec
Link copied to clipboard
open override fun setJvmArgs(arguments: MutableIterable<*>?)
open override fun setJvmArgs(arguments: MutableList<String>?)
Link copied to clipboard
@ReplacedBy(value = "mainClass")
open fun setMain(@Nullable main: String?): JavaExecSpec
Link copied to clipboard
open override fun setMaxHeapSize(heapSize: String?)
Link copied to clipboard
open override fun setMinHeapSize(heapSize: String?)
Link copied to clipboard
open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setOnlyIf(onlyIfClosure: Closure<Any>)
open override fun setOnlyIf(spec: Spec<in Task>)
open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open override fun setProperty(name: String, value: Any)
Link copied to clipboard
open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setStandardInput(inputStream: InputStream): JavaExec
Link copied to clipboard
open override fun setStandardOutput(outputStream: OutputStream): JavaExec
Link copied to clipboard
open override fun setSystemProperties(properties: MutableMap<String, *>)
Link copied to clipboard
open override fun setWorkingDir(dir: File)
open override fun setWorkingDir(dir: Any)
Link copied to clipboard
open override fun shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
open override fun systemProperties(properties: MutableMap<String, *>): JavaExec
Link copied to clipboard
open override fun systemProperty(name: String, value: Any): JavaExec
Link copied to clipboard
open override fun usesService(service: Provider<out BuildService<*>>)
Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

Link copied to clipboard
open override fun workingDir(dir: Any): JavaExec